Skip to main content

DescribeRiskCheckSummary

Description

call the DescribeRiskCheckSummary interface to view the summary information of cloud product configuration check results, including the number of detected risk items, risk rate, number of affected assets, last detection time, and statistical data of various types of detected items.

Request Method

POST

Request Path

/apsara/route/Sas/DescribeRiskCheckSummary

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
SourceIpBODYstringNo1.2.3.4access the IP address of the source.
regionIdBODYstringYesNo sample value for this parameter.region id
LangBODYstringNozhthe language type of the request and receive message. zh: Chinese en: English
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
Statusstringpassthe status of the check item after the check is completed. pass: The check passes, indicating that the check item is normal. failed: If the check fails, the check item is at risk.
CountByStatusarrayNo sample value for this parameter.check item result statistics.
RequestIdstring291B49F9-1685-4005-9D34-606B6F78740Frequest ID of the result.
DisabledRiskCountinteger0the number of checks that failed.
RemainingTimeinteger0estimated check time.
PreviousCountinteger0the number of risk items last checked.
TitlestringIdentity authentication and permissionsthe name of the check item category.
EnabledRiskCountinteger3the number of check items that passed the check.
Countinteger2Number of risk items checked.
RiskCountinteger1number of risk items checked.
RiskLevelCountarrayNo sample value for this parameter.check the number of each type of hazard level. high: high risk medium: medium risk low: low risk
PreviousTimelong1545012926000last check time.
GroupsarrayNo sample value for this parameter.check statistics of item types.
ItemCountinteger4the number of check items.
RiskRatefloat0.25the proportion of the number of risk items checked in the total number of items checked.
Sortinteger1check item types in console all types the order in the drop-down list.
Idlong1check item category ID.
RiskCheckSummarystructNo sample value for this parameter.statistics on the results of cloud product configuration checks.
AffectedAssetCountinteger0the number of assets affected by the risk item in the inspection result.
Keystringmediumthe hazard level of the check item.

Example

Successful Response example

{
"Status":"pass",
"CountByStatus":"",
"RequestId":"291B49F9-1685-4005-9D34-606B6F78740F",
"DisabledRiskCount":"0",
"RemainingTime":"0",
"PreviousCount":"0",
"Title":"Identity authentication and permissions",
"EnabledRiskCount":"3",
"Count":"2",
"RiskCount":"1",
"RiskLevelCount":"",
"PreviousTime":"1545012926000",
"Groups":"",
"ItemCount":"4",
"RiskRate":"0.25",
"Sort":"1",
"Id":"1",
"RiskCheckSummary":"",
"AffectedAssetCount":"0",
"Key":"medium"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}